home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / Math64.h < prev    next >
C/C++ Source or Header  |  1996-05-01  |  7KB  |  258 lines
  1. /*
  2.      File:        Math64.h
  3.  
  4.      Contains:    64-bit integer math Interfaces.
  5.  
  6.      Version:    Technology:    System 8
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __MATH64__
  19. #define __MATH64__
  20.  
  21. #ifndef __TYPES__
  22. #include <Types.h>
  23. #endif
  24.  
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28.  
  29. #if PRAGMA_IMPORT_SUPPORTED
  30. #pragma import on
  31. #endif
  32.  
  33. #if PRAGMA_ALIGN_SUPPORTED
  34. #pragma options align=mac68k
  35. #endif
  36.  
  37. /*
  38. --------------------------------------------------------------------------------
  39.                 These routines are intended to provide C software support for
  40.                 64 bit integer types.  Their behavior should mimic anticipated
  41.                 64 bit hardware. This implementation should replace use of the
  42.                 "wide" type found in PowerPC.
  43.  
  44.     The following routines are available for performing math on 64-bit integers:
  45.     
  46.     S64Max
  47.                 Returns the largest representable SInt64.
  48.     S64Min
  49.                 Returns the smallest (i.e. most negative) SInt64.  Note: the negative
  50.                 (absolute value) of this number is not representable in an SInt64.
  51.                 That means that S64Negate(S64Min) is not representable (in fact,
  52.                 it returns S64Min).
  53.     S64Add
  54.                 Adds two integers, producing an integer result.  If an overflow
  55.                 occurs the result is congruent mod (2^64) as if the operands and
  56.                 result were unsigned.  No overflow is signaled.
  57.     
  58.     S64Subtract
  59.                 Subtracts two integers, producing an integer result.  If an overflow
  60.                 occurs the result is congruent mod (2^64) as if the operands and
  61.                 result were unsigned.  No overflow is signaled.
  62.  
  63.     S64Negate
  64.                 Returns the additive inverse of a signed number (i.e. it returns
  65.                 0 - the number).  S64Negate (S64Min) is not representable (in fact,
  66.                 it returns S64Min).
  67.     
  68.     S64Absolute
  69.                 Returns the absolute value of the number (i.e. the number if
  70.                 it is positive, or 0 - the number if it is negative).
  71.                 See S64Negate above.
  72.                 
  73.     S64Multiply
  74.                 Multiplies two signed numbers, producing a signed result.  Overflow
  75.                 is ignored and the low-order part of the product is returned.  The
  76.                 sign of the result is not guaranteed to be correct if the magnitude
  77.                 of the product is not representable.
  78.     S64Divide
  79.                 Divides dividend by divisor, returning the quotient.  The remainder
  80.                 is returned in *remainder if remainder (the pointer) is non-NULL.
  81.                 The sign of the remainder is the same as the sign of the dividend
  82.                 (i.e. it takes the absolute values of the operands, does the division,
  83.                 then fixes the sign of the quotient and remainder).  If the divisor
  84.                 is zero, then S64Max() will be returned (or S64Min() if the dividend
  85.                 is negative), and the remainder will be the dividend; no error is
  86.                 reported.
  87.     
  88.     S64Set
  89.                 Given an SInt32, returns an SInt64 with the same value.  Use this
  90.                 routine instead of coding 64-bit constants (at least when the
  91.                 constant will fit in an SInt32).
  92.     
  93.     S64SetU
  94.                 Given a UInt32, returns a SInt64 with the same value.
  95.     
  96.     S64Compare
  97.                 Given two signed numbers, left and right, returns an
  98.                 SInt32 that compares with zero the same way left compares with
  99.                 right.  If you wanted to perform a comparison on 64-bit integers
  100.                 of the form:
  101.                         operand_1 <operation> operand_2
  102.                 then you could use an expression of the form:
  103.                         xxxS64Compare(operand_1,operand_2) <operation> 0
  104.                 to test for the same condition.
  105.                 
  106.                 CAUTION: DO NOT depend on the exact value returned by this routine.
  107.                 Only the sign (i.e. positive, zero, or negative) of the result is
  108.                 guaranteed.
  109.  
  110.     S64And, S64Or, S64Eor and S64Not
  111.     
  112.                 Return Boolean (1 or 0) depending on the outcome of the logical
  113.                 operation.
  114.  
  115.     S64BitwiseAnd, S64BitwiseOr, S64BitwiseEor and S64BitwiseNot
  116.     
  117.                 Return the Bitwise result.
  118.                 
  119.     S64ShiftRight and S64ShiftLeft
  120.     
  121.                 The lower 7 bits of the shift argument determines the amount of 
  122.                 shifting.  S64ShiftRight is an arithmetic shift while U64ShiftRight
  123.                 is a logical shift.
  124.  
  125.     SInt64ToLongDouble
  126.                 
  127.                 Converts SInt64 to long double.  Note all SInt64s fit exactly into 
  128.                 long doubles, thus, the binary -> decimal conversion routines
  129.                 in fp.h can be used to achieve SInt64 -> long double -> decimal
  130.                 conversions.
  131.                 
  132.     LongDoubleToSInt64
  133.     
  134.                 Converts a long double to a SInt64.  Any decimal string that fits
  135.                 into a SInt64 can be converted exactly into a long double, using the
  136.                 conversion routines found in fp.h.  Then this routine can be used
  137.                 to complete the conversion to SInt64.
  138.                 
  139.                 
  140.     
  141.     The corresponding UInt64 routines are also included.
  142.     
  143. --------------------------------------------------------------------------------
  144. */
  145. #if FOR_SYSTEM7_AND_SYSTEM8_PREEMPTIVE
  146. #if GENERATINGPOWERPC
  147. extern SInt64 S64Max(void );
  148.  
  149. extern SInt64 S64Min(void );
  150.  
  151. extern SInt64 S64Add(SInt64 x, SInt64 y);
  152.  
  153. extern SInt64 S64Subtract(SInt64 left, SInt64 right);
  154.  
  155. extern SInt64 S64Negate(SInt64 value);
  156.  
  157. extern SInt64 S64Absolute(SInt64 value);
  158.  
  159. extern SInt64 S64Multiply(SInt64 xparam, SInt64 yparam);
  160.  
  161. extern SInt64 S64Divide(SInt64 dividend, SInt64 divisor, SInt64 *remainder);
  162.  
  163. extern SInt64 S64Set(SInt32 value);
  164.  
  165. extern SInt64 S64SetU(UInt32 value);
  166.  
  167. extern SInt32 S32Set(SInt64 value);
  168.  
  169. extern long S64Compare(SInt64 left, SInt64 right);
  170.  
  171. extern Boolean S64And(SInt64 left, SInt64 right);
  172.  
  173. extern Boolean S64Or(SInt64 left, SInt64 right);
  174.  
  175. extern Boolean S64Eor(SInt64 left, SInt64 right);
  176.  
  177. extern Boolean S64Not(SInt64 value);
  178.  
  179. extern SInt64 S64BitwiseAnd(SInt64 left, SInt64 right);
  180.  
  181. extern SInt64 S64BitwiseOr(SInt64 left, SInt64 right);
  182.  
  183. extern SInt64 S64BitwiseEor(SInt64 left, SInt64 right);
  184.  
  185. extern SInt64 S64BitwiseNot(SInt64 value);
  186.  
  187. extern SInt64 S64ShiftRight(SInt64 value, UInt32 shift);
  188.  
  189. extern SInt64 S64ShiftLeft(SInt64 value, UInt32 shift);
  190.  
  191. extern long double SInt64ToLongDouble(SInt64 value);
  192.  
  193. extern SInt64 LongDoubleToSInt64(long double value);
  194.  
  195. extern UInt64 U64Max(void );
  196.  
  197. extern UInt64 U64Add(UInt64 x, UInt64 y);
  198.  
  199. extern UInt64 U64Subtract(UInt64 left, UInt64 right);
  200.  
  201. extern UInt64 U64Multiply(UInt64 xparam, UInt64 yparam);
  202.  
  203. extern UInt64 U64Divide(UInt64 dividend, UInt64 divisor, UInt64 *remainder);
  204.  
  205. extern UInt64 U64Set(SInt32 value);
  206.  
  207. extern UInt64 U64SetU(UInt32 value);
  208.  
  209. extern UInt32 U32SetU(UInt64 value);
  210.  
  211. extern long U64Compare(UInt64 left, UInt64 right);
  212.  
  213. extern Boolean U64And(UInt64 left, UInt64 right);
  214.  
  215. extern Boolean U64Or(UInt64 left, UInt64 right);
  216.  
  217. extern Boolean U64Eor(UInt64 left, UInt64 right);
  218.  
  219. extern Boolean U64Not(UInt64 value);
  220.  
  221. extern UInt64 U64BitwiseAnd(UInt64 left, UInt64 right);
  222.  
  223. extern UInt64 U64BitwiseOr(UInt64 left, UInt64 right);
  224.  
  225. extern UInt64 U64BitwiseEor(UInt64 left, UInt64 right);
  226.  
  227. extern UInt64 U64BitwiseNot(UInt64 value);
  228.  
  229. extern UInt64 U64ShiftRight(UInt64 value, UInt32 shift);
  230.  
  231. extern UInt64 U64ShiftLeft(UInt64 value, UInt32 shift);
  232.  
  233. extern long double UInt64ToLongDouble(UInt64 value);
  234.  
  235. extern UInt64 LongDoubleToUInt64(long double value);
  236.  
  237. extern SInt64 UInt64ToSInt64(UInt64 value);
  238.  
  239. extern UInt64 SInt64ToUInt64(SInt64 value);
  240.  
  241. #endif
  242. #endif
  243.  
  244. #if PRAGMA_ALIGN_SUPPORTED
  245. #pragma options align=reset
  246. #endif
  247.  
  248. #if PRAGMA_IMPORT_SUPPORTED
  249. #pragma import off
  250. #endif
  251.  
  252. #ifdef __cplusplus
  253. }
  254. #endif
  255.  
  256. #endif /* __MATH64__ */
  257.  
  258.